home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1992 June: ROMin Holiday / ADC Developer CD (1992-06) (''ROMin Holiday'')_iso / Developer Connection - 06-1992.iso / Developer Essentials / MPW Interfaces & Libraries / CIncludes / HyperXCmd.h < prev    next >
Encoding:
C/C++ Source or Header  |  1992-01-29  |  9.9 KB  |  254 lines  |  [TEXT/MPS ]
  1. /*
  2.     HyperXCmd.h
  3.     Definition file for HyperCard XCMDs and XFCNs in C.
  4.     Copyright Apple Computer, Inc.  1987-1991
  5.     All rights reserved
  6.  
  7. */
  8.  
  9.  
  10. #ifndef    __HYPERXCMD__
  11. #define    __HYPERXCMD__
  12.  
  13.  
  14. /* Unlike the old days, we have to make sure we have some definitions first… */
  15.  
  16. #ifndef  __TYPES__
  17. #include <Types.h>
  18. #endif
  19.  
  20. #ifndef __EVENTS__
  21. #include <Events.h>
  22. #endif
  23.  
  24. #ifndef __TEXTEDIT__
  25. #include <TextEdit.h>
  26. #endif
  27.  
  28. #ifndef __MENUS__
  29. #include <Menus.h>
  30. #endif
  31.  
  32. #ifndef __STANDARDFILE__
  33. #include <StandardFile.h>
  34. #endif
  35.  
  36.  
  37.  
  38. /* result codes */
  39. #define xresSucc                0
  40. #define xresFail                1
  41. #define xresNotImp                2
  42.  
  43. /* XCMDBlock constants for event.what... */
  44. #define xOpenEvt                1000    /* the first event after you are created */
  45. #define xCloseEvt                1001    /* your window is being forced close (Quit?) */
  46. #define xGiveUpEditEvt            1002    /* you are losing Edit... */
  47. #define xGiveUpSoundEvt            1003    /* you are losing the sound channel... */
  48. #define xHidePalettesEvt        1004    /* someone called HideHCPalettes */
  49. #define xShowPalettesEvt        1005    /* someone called ShowHCPalettes */
  50. #define xEditUndo                1100    /* Edit——Undo */
  51. #define xEditCut                1102    /* Edit——Cut */
  52. #define xEditCopy                1103    /* Edit——Copy */
  53. #define xEditPaste                1104    /* Edit——Paste */
  54. #define xEditClear                1105    /* Edit——Clear */
  55. #define xSendEvt                1200    /* script has sent you a message (text) */
  56. #define xSetPropEvt                1201    /* set a window property */
  57. #define xGetPropEvt                1202    /* get a window property */
  58. #define xCursorWithin            1300    /* cursor is within the window */
  59. #define xMenuEvt                1400    /* user has selected an item in your menu */
  60. #define xMBarClickedEvt            1401    /* a menu is about to be shown--update if needed */
  61.  
  62. #define xShowWatchInfoEvt        1501    /* for variable and message watchers */
  63. #define xScriptErrorEvt            1502    /* place the insertion point */
  64. #define xDebugErrorEvt            1503    /* user clicked "Debug" at a complaint */
  65. #define xDebugStepEvt            1504    /* hilite the line */
  66. #define xDebugTraceEvt            1505    /* same as step but tracing */
  67. #define xDebugFinishedEvt        1506    /* script ended */
  68.  
  69. #define paletteProc                2048    /* Windoid with grow box */
  70. #define palNoGrowProc            2052    /* standard Windoid defproc */
  71. #define palZoomProc                2056    /* Windoid with zoom and grow */
  72. #define palZoomNoGrow            2060    /* Windoid with zoom and no grow */
  73. #define hasZoom                    8
  74. #define hasTallTBar                2
  75. #define toggleHilite            1
  76.  
  77.  
  78. #define maxCachedChecks            16        /* maximum number of checkpoints in a script */
  79.  
  80.  
  81. /* paramCount is set to these constants when first calling special XThings */
  82. #define xMessageWatcherID        = -2;
  83. #define xVariableWatcherID        = -3;
  84. #define xScriptEditorID            = -4;
  85. #define xDebuggerID                = -5;
  86.  
  87. /* XTalkObjectPtr->objectKind values */
  88. #define stackObj                1
  89. #define bkgndObj                2
  90. #define cardObj                    3
  91. #define fieldObj                4
  92. #define buttonObj                5
  93.  
  94.  
  95. typedef struct XCmdBlock *XCmdPtr; 
  96. struct XCmdBlock {
  97.     short paramCount;         /* If = -1 then new use for XWindoids */
  98.     Handle params[16];
  99.     Handle returnValue;
  100.     Boolean passFlag;
  101.  
  102.     Ptr entryPoint;             /* to call back to HyperCard */
  103.     short request;
  104.     short result;
  105.     long inArgs[8];
  106.     long outArgs[4];
  107. };
  108.  
  109. typedef struct XWEventInfo *XWEventInfoPtr; 
  110. struct XWEventInfo {
  111.     EventRecord event;
  112.     WindowPtr eventWindow;
  113.     long eventParams[9];
  114.     Handle eventResult;
  115. };
  116.  
  117. typedef struct XTalkObject *XTalkObjectPtr;
  118. struct XTalkObject {
  119.     short objectKind;        /* stack, bkgnd, card, field, or button */
  120.     long stackNum;            /* reference number of the source stack */
  121.     long bkgndID;
  122.     long cardID;
  123.     long buttonID;
  124.     long fieldID;
  125. };
  126.  
  127.  
  128. typedef struct CheckPts *CheckPtPtr;
  129. typedef CheckPtPtr *CheckPtHandle; 
  130. struct CheckPts {
  131.     short checks[maxCachedChecks];
  132. };
  133.  
  134. #ifdef __cplusplus
  135. extern "C" {
  136. #endif
  137.  
  138. /****  HyperTalk Utilities  ****/
  139. pascal Handle EvalExpr(XCmdPtr paramPtr, StringPtr expr);
  140. pascal void SendCardMessage(XCmdPtr paramPtr, StringPtr msg);
  141. pascal void SendHCMessage(XCmdPtr paramPtr, StringPtr msg);
  142. pascal void RunHandler(XCmdPtr paramPtr, Handle handler);
  143.  
  144. /****  Memory Utilities  ****/
  145. pascal Handle GetGlobal(XCmdPtr paramPtr, StringPtr globName);
  146. pascal void SetGlobal(XCmdPtr paramPtr, StringPtr globName, Handle globValue);
  147. pascal void ZeroBytes(XCmdPtr paramPtr, Ptr dstPtr, long longCount);
  148.  
  149. /****  String Utilities  ****/
  150. pascal void ScanToReturn(XCmdPtr paramPtr, Ptr *scanPtr);
  151. pascal void ScanToZero(XCmdPtr paramPtr, Ptr *scanPtr);
  152. pascal Boolean StringEqual(XCmdPtr paramPtr, StringPtr str1, StringPtr str2);
  153. pascal long StringLength(XCmdPtr paramPtr, Ptr strPtr);
  154. pascal Ptr StringMatch(XCmdPtr paramPtr, StringPtr pattern, Ptr target);
  155. pascal void ZeroTermHandle(XCmdPtr paramPtr, Handle hndl);                                
  156.  
  157. /****  String Conversions  ****/
  158. pascal void BoolToStr(XCmdPtr paramPtr, Boolean bool, StringPtr str);
  159. pascal void ExtToStr(XCmdPtr paramPtr, extended80 num, StringPtr str);
  160. pascal void LongToStr(XCmdPtr paramPtr, long posNum, StringPtr str);
  161. pascal void NumToHex(XCmdPtr paramPtr, long num, short nDigits, StringPtr str);
  162. pascal void NumToStr(XCmdPtr paramPtr, long num, StringPtr str);
  163. pascal Handle PasToZero(XCmdPtr paramPtr, StringPtr str);
  164. pascal void PointToStr(XCmdPtr paramPtr, Point pt, StringPtr str);                        
  165. pascal void RectToStr(XCmdPtr paramPtr, Rect *rct, StringPtr str);                        
  166. pascal void ReturnToPas(XCmdPtr paramPtr, Ptr zeroStr, StringPtr pasStr);
  167. pascal Boolean StrToBool(XCmdPtr paramPtr, StringPtr str);
  168. pascal extended80 StrToExt(XCmdPtr paramPtr, StringPtr str);
  169. pascal long StrToLong(XCmdPtr paramPtr, StringPtr str);
  170. pascal long StrToNum(XCmdPtr paramPtr, StringPtr str);
  171. pascal void StrToPoint(XCmdPtr paramPtr, StringPtr str, Point *pt);                        
  172. pascal void StrToRect(XCmdPtr paramPtr, StringPtr str, Rect *rct);                        
  173. pascal void ZeroToPas(XCmdPtr paramPtr, Ptr zeroStr, StringPtr pasStr);
  174.  
  175. /****  Field Utilities  ****/
  176. pascal Handle GetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID);
  177. pascal Handle GetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag, StringPtr fieldName);
  178. pascal Handle GetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum);
  179. pascal void SetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  180.     Handle fieldVal);
  181. pascal void SetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag,
  182.     StringPtr fieldName, Handle fieldVal);
  183. pascal void SetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum,
  184.     Handle fieldVal);
  185. pascal TEHandle GetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  186.     short fieldNum, StringPtr fieldNamePtr);                                                    
  187. pascal void SetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  188.     short fieldNum, StringPtr fieldNamePtr, TEHandle fieldTE);                                    
  189.  
  190. /****  Miscellaneous Utilities  ****/  /* ALL NEW */
  191. pascal void BeginXSound(XCmdPtr paramPtr, WindowPtr window);
  192. pascal void EndXSound(XCmdPtr paramPtr);
  193. pascal Boolean GetFilePath(XCmdPtr paramPtr, StringPtr fileName, short numTypes, SFTypeList typeList,
  194.     Boolean askUser, OSType *fileType, StringPtr fullName);
  195. pascal void GetXResInfo(XCmdPtr paramPtr, short *resFile, short *resID, ResType *rType, StringPtr name);
  196. pascal void Notify(XCmdPtr paramPtr);
  197. pascal void SendHCEvent(XCmdPtr paramPtr, EventRecord *event);
  198. pascal void SendWindowMessage(XCmdPtr paramPtr, WindowPtr windPtr, 
  199.     StringPtr windowName, Handle msg);
  200. pascal WindowPtr FrontDocWindow(XCmdPtr paramPtr);
  201. pascal long StackNameToNum(XCmdPtr paramPtr, StringPtr stackName);
  202. pascal short ShowHCAlert(XCmdPtr paramPtr, short dlgID, StringPtr promptStr);
  203.  
  204. /****  Creating and Disposing XWindoids  ****/  /* ALL NEW */
  205. pascal WindowPtr NewXWindow(XCmdPtr paramPtr, Rect *boundsRect, StringPtr title, 
  206.    Boolean visible, short procID, Boolean color, Boolean floating);
  207. pascal WindowPtr GetNewXWindow(XCmdPtr paramPtr, ResType templateType, short 
  208.    templateID, Boolean color, Boolean floating);
  209. pascal void CloseXWindow(XCmdPtr paramPtr, WindowPtr window);
  210.  
  211. /****  XWindoid Utilities  ****/  /* ALL NEW */
  212. pascal void HideHCPalettes(XCmdPtr paramPtr);
  213. pascal void ShowHCPalettes(XCmdPtr paramPtr);
  214. pascal void RegisterXWMenu(XCmdPtr paramPtr, WindowPtr window, MenuHandle menu, Boolean registering);
  215. pascal void SetXWIdleTime(XCmdPtr paramPtr, WindowPtr window, long interval);
  216. pascal void XWHasInterruptCode(XCmdPtr paramPtr, WindowPtr window, Boolean haveCode);
  217. pascal void XWAlwaysMoveHigh(XCmdPtr paramPtr, WindowPtr window, Boolean moveHigh);
  218. pascal void XWAllowReEntrancy(XCmdPtr paramPtr, WindowPtr window, Boolean allowSysEvts, Boolean allowHCEvts);
  219.  
  220. /****  Text Editing Utilities  ****/  /* ALL NEW */
  221. pascal void BeginXWEdit(XCmdPtr paramPtr, WindowPtr window);
  222. pascal void EndXWEdit(XCmdPtr paramPtr, WindowPtr window);
  223. pascal Ptr HCWordBreakProc(XCmdPtr paramPtr);
  224. pascal void PrintTEHandle(XCmdPtr paramPtr, TEHandle hTE, StringPtr header);
  225.  
  226. /****  Script Editor support  ****/  /* ALL NEW */
  227. pascal CheckPtHandle GetCheckPoints(XCmdPtr paramPtr);
  228. pascal void SetCheckPoints(XCmdPtr paramPtr, CheckPtHandle checkLines);
  229. pascal void FormatScript(XCmdPtr paramPtr, Handle scriptHndl, long *insertionPoint, Boolean quickFormat);
  230. pascal void SaveXWScript(XCmdPtr paramPtr, Handle scriptHndl);
  231. pascal void GetObjectName(XCmdPtr paramPtr, XTalkObjectPtr object, StringPtr objName);
  232. pascal void GetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr object, Handle *scriptHndl);
  233. pascal void SetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr object, Handle scriptHndl);
  234.  
  235. /****  Debugging Tools support  ****/  /* ALL NEW */
  236. pascal void AbortScript(XCmdPtr paramPtr);
  237. pascal void GoScript(XCmdPtr paramPtr);
  238. pascal void StepScript(XCmdPtr paramPtr, Boolean stepInto);
  239. pascal void CountHandlers(XCmdPtr paramPtr, short *handlerCount);
  240. pascal void GetHandlerInfo(XCmdPtr paramPtr, short handlerNum, StringPtr handlerName, 
  241.                                   StringPtr objectName, short *varCount);
  242. pascal void GetVarInfo(XCmdPtr paramPtr, short handlerNum, short varNum, StringPtr varName, 
  243.                               Boolean *isGlobal, StringPtr varValue, Handle varHndl);
  244. pascal void SetVarValue(XCmdPtr paramPtr, short handlerNum, short varNum, Handle varHndl);
  245. pascal Handle GetStackCrawl(XCmdPtr paramPtr);
  246. pascal void TraceScript(XCmdPtr paramPtr, Boolean traceInto);
  247.  
  248. #ifdef __cplusplus
  249. }
  250. #endif
  251.  
  252.  
  253. #endif
  254.